Lấy thông tin Bot

Lấy dữ liệu Bot theo ext_bot_id

HTTP request

GET https://{app_id}.api.piscale.com/chat-bot/v1.0/bots/{ext_bot_id}

Parameters

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
ext_bot_id	string	Mã bot	✓

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ
{
    "message_code": "M200",
    "message": "Success",
    "data": {
        "user_id": "5CEAL1bPI6:1697012858",
        "display_name": "Bot Chăm Sóc Khách Hàng",
        "description": "",
        "avatar_url": "https://images.samsung.com/is/image/samsung/assets/vn/about-us/brand/logo/mo/256_144_3.png",
        "status": 1,
        "ext_tenant_id": "6872016393176737",
        "created_at": 1697012858016,
        "updated_at": 1697012858016,
        "config": {
            "webhook_url": "https://be87-2405-4803-f7fb-8570-8d9e-c024-84e7-953b.ngrok.io/api/webhook",
            "receive_all_msg": 1
        },
        "token": "6872016393686756:u1r9NLQijr58lrEGDG789jHskksWl6WjLTa",
        "ext_bot_id": "6872016393686756",
        "is_global": 1
    }
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp
data.user_id	string	Id trong hệ thống của bạn, nếu không truyền PiScale sẽ tạo một id cho bot
data.display_name	string	Tên hiển thị của bot
data.avatar_url	string	Url ảnh đại diện của bot
data.description	string	Mô tả bot
data.ext_tenant_id	string	Bot bắt buộc phải thuộc 1 tenant
data.ext_bot_id	string	ID của bot trên hệ thống PiScale
data.is_global	int	Phạm vi hoạt động của bot.
data.config.webhook_url	string	Thiết lập endpoint mà bạn muốn nhận được event
data.config.receive_all_msg	int	Nếu bạn muốn `nhận được tất cả tin nhắn` trong cuộc hội thoạt có bot thì thiết lập giá trị là `1`. Mặc định PiScale sẽ đẩy dữ liệu về đầu webhook nếu phát hiện Bot được nhắc đến hoặc tin nhắn chứa `command`

HTTP request​

Parameters​

Response​

HTTP request

Parameters

Response